Indexed DB - IDBCursor

HTML5 JS API Index > Indexed DB Tutorials & Specs

IDBCursor

Extended by IDBCursorWithValue
Properties

IDBCursorDirection
direction
On getting, provide the traversal direction of the cursor.
any
key
Returns the cursor's current key. Note that if this property returns an object (specifically an Array), it returns the same object instance every time it is inspected, until the cursor's key is changed. This means that if the object is modified, those modifications will be seen by anyone inspecting the value of the cursor.
any
primaryKey
Returns the cursor's current effective key. Note that if this property returns an object (specifically an Array), it returns the same object instance every time it is inspected, until the cursor's effective key is changed. This means that if the object is modified, those modifications will be seen by anyone inspecting the value of the cursor.
(IDBObjectStore or IDBIndex)
source
On getting, returns the IDBObjectStore or IDBIndex which this cursor is iterating. This function never returns null or throws an exception, even if the cursor is currently being iterated, has iterated past its end, or its transaction is not active.
Operations

void
advance(unsigned long count)
If the value for count is 0 (zero), the implementation MUST throw a TypeError. If the transaction this IDBCursor belongs to is not active, the implementation MUST throw a DOMException of type TransactionInactiveError. If the cursor's source or effective object store has been deleted, the implementation MUST throw a DOMException of type InvalidStateError.
void
continue(optional any key)
If the transaction this IDBCursor belongs to is not active, the implementation MUST throw a DOMException of type TransactionInactiveError. If the cursor's source or effective object store has been deleted, the implementation MUST throw a DOMException of type InvalidStateError.
IDBRequest
delete()
If the transaction this IDBCursor belongs to has its mode set to "readonly", the implementation MUST throw a DOMException of type ReadOnlyError. If the transaction this IDBCursor belongs to is not active, the implementation MUST throw a DOMException of type TransactionInactiveError.
IDBRequest
update(any value)
If the transaction this IDBCursor belongs to has its mode set to "readonly", the implementation MUST throw a DOMException of type ReadOnlyError. If the transaction this IDBCursor belongs to is not active, the implementation MUST throw a DOMException of type TransactionInactiveError.
Referenced by
IDBRequest source

Properties
IDBCursorDirection	direction On getting, provide the traversal direction of the cursor.
any	key Returns the cursor's current key. Note that if this property returns an object (specifically an Array), it returns the same object instance every time it is inspected, until the cursor's key is changed. This means that if the object is modified, those modifications will be seen by anyone inspecting the value of the cursor.
any	primaryKey Returns the cursor's current effective key. Note that if this property returns an object (specifically an Array), it returns the same object instance every time it is inspected, until the cursor's effective key is changed. This means that if the object is modified, those modifications will be seen by anyone inspecting the value of the cursor.
(IDBObjectStore or IDBIndex)	source On getting, returns the IDBObjectStore or IDBIndex which this cursor is iterating. This function never returns null or throws an exception, even if the cursor is currently being iterated, has iterated past its end, or its transaction is not active.

Operations
void	advance(unsigned long count) If the value for count is 0 (zero), the implementation MUST throw a TypeError. If the transaction this IDBCursor belongs to is not active, the implementation MUST throw a DOMException of type TransactionInactiveError. If the cursor's source or effective object store has been deleted, the implementation MUST throw a DOMException of type InvalidStateError.
void	continue(optional any key) If the transaction this IDBCursor belongs to is not active, the implementation MUST throw a DOMException of type TransactionInactiveError. If the cursor's source or effective object store has been deleted, the implementation MUST throw a DOMException of type InvalidStateError.
IDBRequest	delete() If the transaction this IDBCursor belongs to has its mode set to "readonly", the implementation MUST throw a DOMException of type ReadOnlyError. If the transaction this IDBCursor belongs to is not active, the implementation MUST throw a DOMException of type TransactionInactiveError.
IDBRequest	update(any value) If the transaction this IDBCursor belongs to has its mode set to "readonly", the implementation MUST throw a DOMException of type ReadOnlyError. If the transaction this IDBCursor belongs to is not active, the implementation MUST throw a DOMException of type TransactionInactiveError.